-
-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor(python): Rename utils
module to _utils
to explicitly mark it as private
#14772
Conversation
I had it in my backlog to ask about making For plugins, the other thing I'd love would be a public from polars.plugin_utils import (
get_shared_lib_location,
parse_into_expr,
) Having said that, with this change, all plugins will break, even though authors just followed official guidance. I'd really appreciate it if
could keep working for now, but just emit a deprecation warning, advising to use whatever the replacement path is. Given that |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #14772 +/- ##
==========================================
- Coverage 80.94% 80.93% -0.01%
==========================================
Files 1324 1325 +1
Lines 171941 171904 -37
Branches 2450 2452 +2
==========================================
- Hits 139176 139129 -47
- Misses 32296 32305 +9
- Partials 469 470 +1 ☔ View full report in Codecov by Sentry. |
All right, will keep that unchanged in this PR. Can follow up with a PR to add a |
awesome, thanks! I'll repurpose #14779 as a follow-up then once this is in |
As discussed on Discord.
In our deprecation policy, we explicitly state that changing internal module paths is not considered a breaking change. To avoid surprises for users that do not read the policy, I am explicitly marking the utils module as private.
I did notice that the
_get_shared_lib_location
util is used in the plugins docs. It is not used internally. What is the deal with this (private) function and should we make it public? @MarcoGorelli would appreciate your input!